home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / lib232.zip / MAKELIST.DOC < prev    next >
Text File  |  1990-10-14  |  16KB  |  299 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                   M a k e L i s t
  9.  
  10.                                    Version 1.01
  11.  
  12.                                 Add-on Command For
  13.                                 The Liberator v2.3
  14.  
  15.                      Copyright (C) 1990 Liberation Enterprises
  16.  
  17.                                All rights reserved.
  18.  
  19.                                         ~~~
  20.      DESCRIPTION:  MakeList (MAKELIST.SLC) is a compiled Telix SALT script
  21.      that will send user-defined commmands to a BBS, then capture the results
  22.      of the commands to any file.  Its purpose is to allow you to capture the
  23.      results of a Locate, New Files, or Zippy Scan command from either
  24.      PCBoard or ProDoor.  The resulting text is then automatically formatted
  25.      for use as a Liberator Download List and can be used for downloading in
  26.      the same session.  If desired, you may also manually edit the list prior
  27.      to downloading.  You define the BBS command(s) to send, and File List
  28.      name in one of the Custom Command(s) options of a Liberator v2.3 Command
  29.      File (preferably Custom Command 2).  MakeList will not work with earlier
  30.      versions of The Liberator.
  31.  
  32.      Standard conventions are used in this document to help illustrate
  33.      syntax:
  34.  
  35.      o  Text inside two angle brackets <label> is used as a reference to a
  36.         certain items.  Do not type in the <label> itself, but instead
  37.         substitute it with actual text as defined below.
  38.      o  Square brackets [] surround optional items.  You can leave these
  39.         items out if desired, but do not include the brackets if used.
  40.      o  A vertical bar | means OR, when more than one option is available. 
  41.         The actual options to use will be on either side of the bar.  Do
  42.         not specify the actual |.
  43.      o  n1, n2, etc., signifies a number (1,2,10,50, etc).
  44.      o  Three periods ... means that more items of the same form may
  45.         follow.
  46.  
  47.      Now, hopefully this line below will make some sense, and not look like
  48.      secret code:
  49.  
  50.      USAGE:  @MakeList <list> <command> [/d|/e][/#n1[,n2]...][/Edit]
  51.  
  52.      Each item is explained below.  Note that <list> MUST be the first item  
  53.      specified, but following items may appear in any order.  <command> must
  54.      be separated from other options by either a space or a foward slash (/). 
  55.      If you precede <command> with a switch, make sure you leave a space
  56.      between the two.  If you follow <command> with a switch, no space is
  57.      necessary since MakeList will recognize the / as a switch.  Note that
  58.  
  59.  
  60.  
  61.  
  62.           The  L i b e r a t o r  v2.32               MAKELIST.DOC - Page 2
  63.           
  64.           
  65.  
  66.      with some program's command line switches, you may substitute the slash
  67.      (/) with a hyphen (-), but this was not implemented in MakeList.
  68.  
  69.      @MakeList = The '@' character, when used in a Liberator Custom Command,
  70.                  means to run a script.  @MakeList (or @makelist @MAKELIST)
  71.                  tells The Liberator to run the script MAKELIST.SLC, which
  72.                  should have accompanied this document.  The script must be
  73.                  located in the current directory, or in the directory
  74.                  defined with the Telix <Alt-O> command as your 'Script
  75.                  Directory'.  If you don't have a script directory defined in
  76.                  Telix, it is highly recommended that you do so immediately,
  77.                  then copy MAKELIST.SLC (and The Liberator) into the defined
  78.                  directory.
  79.  
  80.      <list>    = Name of file to capture results of <command> to.  The
  81.                  filename can be specified in two forms:
  82.  
  83.                  [d:][\path\]LISTNAME[.ext] -- An actual filename (drive,
  84.                  path and extension optional) or:
  85.  
  86.                  %D (or %d) -- Causes The Liberator to use the file named in
  87.                  the "Download List" option of the currently executing
  88.                  Command File.  If you specify %D without defining a filename
  89.                  in the Download List option of the same Command File, The
  90.                  Liberator will construct a filename, comprised of the name
  91.                  of the current Command File, plus the extension .DL (for
  92.                  Download List).
  93.  
  94.      <command> = PCBoard/ProDoor command(s) to send to the BBS (F)ile
  95.                  Directories, N)ew Files, L)ocate, Z)ippy Scan, etc.)  If you
  96.                  define the @MakeList command line in Custom Command 1, then
  97.                  <command> will be sent to PCBoard (unless you are already in
  98.                  ProDoor for some reason).  If you define the command in
  99.                  Custom Command 2, and a ProDoor is defined in the CFG file,
  100.                  ProDoor will be opened and the script will execute there,
  101.                  allowing you to take advantage of ProDoor commands, and
  102.                  batch transfers (this is a function of The Liberator, and
  103.                  occurs with all Custom Commands).  It is recommended that
  104.                  you use Custom Command 2 whenever possible with MakeList.
  105.  
  106.                  To specify a Ctrl (control) character within <command> (such
  107.                  as Carriage Return which is Ctrl-M), precede the character
  108.                  with a caret (^).  A vertical bar (|) in <command> causes a
  109.                  ^M (<Enter>), then waits for one of the eight Liberator
  110.                  'key' prompts defined in each Configuration.  Use either the
  111.                  | or ^M to specify more than one command if desired.  A
  112.                  tilde (~) may also be used to specify a half-second pause. 
  113.                  See the examples below for uses of these characters in
  114.                  <command>.  ^M is always sent after the final character of
  115.                  <command>, so you need not specify the final carriage
  116.                  return.  If you do specify a trailing ^M, then two carriage
  117.                  returns will be sent.
  118.  
  119.  
  120.  
  121.  
  122.           The  L i b e r a t o r  v2.32               MAKELIST.DOC - Page 3
  123.           
  124.           
  125.  
  126.                  The "More" (PCBoard) and "ProDoor More" prompts (defined in
  127.                  each Liberator Configuration) are automatically handled by
  128.                  MakeList by sending NS (Non-Stop) when found.  The "Pause"
  129.                  prompt is also handled as usual by sending a carriage
  130.                  return.  Most times you will add an NS (non-stop) to the end
  131.                  of <command> to avoid the 'More' prompt, but if you forget,
  132.                  MakeList will handle these prompts for you.  If MakeList
  133.                  hangs at either of these prompts due to a different prompt
  134.                  format, you may reconfigure both directly in the board's
  135.                  Liberator CFG File, since MakeList gets the prompts directly
  136.                  from the Configuration.
  137.  
  138.      /d|/e       All text resulting from <command> is captured and inserted
  139.                  at the BEGINNING of <list> if it already exists. (This is to
  140.                  allow quick editing, and so newly listed files will be
  141.                  downloaded first.)  To change this, use the /d or /e switch
  142.                  (or /E /D if you prefer).  /d causes <list> to be Deleted if
  143.                  it is found, /e causes captured text to be appended to the
  144.                  End of <list>, if it already exists.
  145.  
  146.      /#n1[,n2] = Specifies conference(s) to execute <command> in.  This
  147.                  option, if used, must start with the '/#' characters, and NO
  148.                  SPACES are permitted until all conferences are specified. 
  149.                  You may use as many conference numbers as will fit in the
  150.                  Custom Commmand (64 character maximum), each separated by a
  151.                  comma, or omit this option entirely to execute <command>
  152.                  only in the current conference.  If more than one conference
  153.                  is specified, <command> will be sent to the BBS in each of
  154.                  the conferences.  Commas are only necessary when more than